<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
        <head><title>class Query in com.google.gdata</title>
        <meta http-equiv="content-type" content="text/html; charset=UTF8"></meta><meta content="scaladoc (version 2.7.1.r14655-b20080415113712)" name="generator"></meta><link href="../../../style.css" type="text/css" rel="stylesheet"></link><script type="text/javascript" src="../../../script.js"></script>
        </head>
        <body onload="init()">
        <table summary="" class="navigation">
        <tr>
          <td class="navigation-links" valign="top">
            <!-- <table><tr></tr></table> -->
          </td>
          <td align="right" valign="top" style="white-space:nowrap;" rowspan="2">
            <div class="doctitle-larger">GData Scala Client Library Documentation</div>
          </td>
        </tr>
        <tr><td></td></tr>
      </table>
        
      <div class="entity">
        <a href="../../../com/google/gdata$package.html" target="_self">com.google.gdata</a>
        <br></br>
        <span class="entity">class  Query</span>
      </div><hr></hr>
      <div class="source">
        [source: <a href="" class="com/google/gdata/Query"><code>com/google/gdata/Query.scala</code></a>]
      </div><hr></hr>
      <a name="Query"></a><dl>
      <dt>
        
        <code></code>
        <code>class</code>
        <em>Query</em>(<code>val </code><em>searchQuery</em> : <a href="../../../com/google/gdata/SearchQuery.html" target="_self">SearchQuery</a>)
      </dt>
      <dd><code> extends </code><a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a></dd>
    </dl>
      <dl><dd>Base class for GData queries. It has a category part and a search query part. 
 Categories are added using the '/' operator. The search query is added using
 'suchThat'. Retrieve the URL by calling 'mkUrl(base)'. It returns a URL looking
 like 'base/-/categories/../lastCategory?q=<searchquery>'. It takes care of URL
 encoding.
 
 It handles the default GData parameters (author, alt, updated-min, updated-max, 
 published-min, published-max, start-index, max-results). @see <a href=
 "http://code.google.com/apis/gdata/reference.html#Queries">GData queries</a>.
 
 Subclasses should override 'searchName' to change 'q' to something else. New
 parameters should be implemented as methods in terms of 'addParam'.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Author</b></dt><dd>Iulian Dragos</dd></dl>
    <dl>
      <dt style="margin:10px 0 0 20px;"><b>Direct Known Subclasses:</b></dt>
      <dd><a href="../../../com/google/gdata/calendar/CalendarQuery.html" target="_self">CalendarQuery</a>, <a href="../../../com/google/gdata/youtube/YouTubeQuery.html" target="_self">YouTubeQuery</a></dd>
      </dl><hr></hr>
      <table summary="" cellpadding="3" class="member">
      <tr><td class="title" colspan="2">Additional Constructor Summary</td></tr>
      <tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#this%28%29" target="_self">this</a></em>
         : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        
      </td>
    </tr>
      </table>


<table summary="" cellpadding="3" class="member">
      <tr><td class="title" colspan="2">Method Summary</td></tr>
      <tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#%26%28com.google.gdata.SearchQuery%29" target="_self">&amp;</a></em>
        (<em>q</em> : <a href="../../../com/google/gdata/SearchQuery.html" target="_self">SearchQuery</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#%2F%28String%29" target="_self">/</a></em>
        (<em>cat</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Add a category to this query.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#%2F%28com.google.gdata.CategoryQuery%29" target="_self">/</a></em>
        (<em>q</em> : <a href="../../../com/google/gdata/CategoryQuery.html" target="_self">CategoryQuery</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Add a category to this query.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#addParam%28String%2CString%29" target="_self">addParam</a></em>
        (<em>name</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>, <em>value</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Add a custom parameter to this query. Use method calls for standard parameters. 
   Subclasses should use this method to implement custom search parameters. It
   url-encodes the given value.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#alt%28String%29" target="_self">alt</a></em>
        (<em>alt</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Return in the given alternative representation. Valid alternatives are 'atom' and 'rss'.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#author%28String%29" target="_self">author</a></em>
        (<em>a</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Returns entries where the author name and/or email address match the given string.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#matching%28com.google.gdata.SearchQuery%29" target="_self">matching</a></em>
        (<em>q</em> : <a href="../../../com/google/gdata/SearchQuery.html" target="_self">SearchQuery</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Set the default text query. This is usually the 'q' parameter.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#maxResults%28Int%29" target="_self">maxResults</a></em>
        (<em>n</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Maximum number of results to be retrieved.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#mkUrl%28String%29" target="_self">mkUrl</a></em>
        (<em>base</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>
        
        <div>Return the URL query given the base URL. The URL should not have a trailing '/'.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#publishedMax%28com.google.gdata.data.util.DateTime%29" target="_self">publishedMax</a></em>
        (<em>dt</em> : <a href="../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Return entries published before (exclusive) than the given date.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#publishedMin%28com.google.gdata.data.util.DateTime%29" target="_self">publishedMin</a></em>
        (<em>dt</em> : <a href="../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Return entries published later (inclusive) than the given date.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#searchName" target="_self">searchName</a></em>
         : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>
        
        <div>The parameter name for text searches. This is used for the deafult seach query, 
   introduced by @code suchThat.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#startIndex%28Int%29" target="_self">startIndex</a></em>
        (<em>idx</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>1-based index of the first result to be retrieved.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#updatedMax%28com.google.gdata.data.util.DateTime%29" target="_self">updatedMax</a></em>
        (<em>dt</em> : <a href="../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Return entries updated before (exclusive) than the given date.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#updatedMin%28com.google.gdata.data.util.DateTime%29" target="_self">updatedMin</a></em>
        (<em>dt</em> : <a href="../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
        
        <div>Return entries updated later (inclusive) than the given date.</div>
      </td>
    </tr>
<tr>
      <td class="modifiers" valign="top"> 
        <code> def</code>
      </td>
      <td class="signature">
        <em><a href="../../../com/google/gdata/Query.html#%7C%28com.google.gdata.SearchQuery%29" target="_self">|</a></em>
        (<em>q</em> : <a href="../../../com/google/gdata/SearchQuery.html" target="_self">SearchQuery</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
        
        
      </td>
    </tr>
      </table><table summary="" cellpadding="3" class="inherited">
        <tr><td class="title" colspan="2">
          Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html" target="_self">AnyRef</a>
        </td></tr>
        <tr><td class="signature" colspan="2">
          <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#getClass%28%29" target="_self">getClass</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#hashCode%28%29" target="_self">hashCode</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#equals%28Any%29" target="_self">equals</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#clone%28%29" target="_self">clone</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#toString%28%29" target="_self">toString</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notify%28%29" target="_self">notify</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#notifyAll%28%29" target="_self">notifyAll</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28Long%2CInt%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#wait%28%29" target="_self">wait</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#finalize%28%29" target="_self">finalize</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%3D%3D%28AnyRef%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#%21%3D%28AnyRef%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#eq%28AnyRef%29" target="_self">eq</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#ne%28AnyRef%29" target="_self">ne</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/AnyRef.html#synchronized%28T0%29" target="_self">synchronized</a>
        </td></tr>
      </table><table summary="" cellpadding="3" class="inherited">
        <tr><td class="title" colspan="2">
          Methods inherited from <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html" target="_self">Any</a>
        </td></tr>
        <tr><td class="signature" colspan="2">
          <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%3D%3D%28Any%29" target="_self">==</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#%21%3D%28Any%29" target="_self">!=</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#isInstanceOf" target="_self">isInstanceOf</a>, <a href="http://www.scala-lang.org/docu/files/api/scala/Any.html#asInstanceOf" target="_self">asInstanceOf</a>
        </td></tr>
      </table>


      <table summary="" cellpadding="3" class="member-detail">
          <tr><td class="title">Additional Constructor Details</td></tr>
        </table><div><a name="this%28%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>this</em> : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl><hr></hr></div>


<table summary="" cellpadding="3" class="member-detail">
          <tr><td class="title">Method Details</td></tr>
        </table><div><a name="%26%28com.google.gdata.SearchQuery%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>&amp;</em>(<em>q</em> : <a href="../../../com/google/gdata/SearchQuery.html" target="_self">SearchQuery</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl><hr></hr>
<a name="%7C%28com.google.gdata.SearchQuery%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>|</em>(<em>q</em> : <a href="../../../com/google/gdata/SearchQuery.html" target="_self">SearchQuery</a>) : <a href="http://www.scala-lang.org/docu/files/api/scala/Unit.html" target="_self">Unit</a>
      </dt>
      <dd></dd>
    </dl><hr></hr>
<a name="%2F%28com.google.gdata.CategoryQuery%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>/</em>(<em>q</em> : <a href="../../../com/google/gdata/CategoryQuery.html" target="_self">CategoryQuery</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Add a category to this query.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="%2F%28String%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>/</em>(<em>cat</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Add a category to this query.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="matching%28com.google.gdata.SearchQuery%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>matching</em>(<em>q</em> : <a href="../../../com/google/gdata/SearchQuery.html" target="_self">SearchQuery</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Set the default text query. This is usually the 'q' parameter.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="mkUrl%28String%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>mkUrl</em>(<em>base</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Return the URL query given the base URL. The URL should not have a trailing '/'.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="searchName"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>searchName</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>The parameter name for text searches. This is used for the deafult seach query, 
   introduced by @code suchThat.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="addParam%28String%2CString%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>addParam</em>(<em>name</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>, <em>value</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Add a custom parameter to this query. Use method calls for standard parameters. 
   Subclasses should use this method to implement custom search parameters. It
   url-encodes the given value.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="author%28String%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>author</em>(<em>a</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Returns entries where the author name and/or email address match the given string.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="alt%28String%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>alt</em>(<em>alt</em> : <a href="" target="contentFrame" class="java/lang/String">java.lang.String</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Return in the given alternative representation. Valid alternatives are 'atom' and 'rss'.</dd></dl>
      <dl><dt style="margin:10px 0 0 20px;">
        <b>Throws</b></dt><dd><code>IllegalArgumentException - </code>if something other than rss and atom is given.</dd></dl>
    <hr></hr>
<a name="updatedMin%28com.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>updatedMin</em>(<em>dt</em> : <a href="../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Return entries updated later (inclusive) than the given date.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="updatedMax%28com.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>updatedMax</em>(<em>dt</em> : <a href="../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Return entries updated before (exclusive) than the given date.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="publishedMin%28com.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>publishedMin</em>(<em>dt</em> : <a href="../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Return entries published later (inclusive) than the given date.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="publishedMax%28com.google.gdata.data.util.DateTime%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>publishedMax</em>(<em>dt</em> : <a href="../../../com/google/gdata/data/util/DateTime.html" target="_self">DateTime</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Return entries published before (exclusive) than the given date.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="startIndex%28Int%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>startIndex</em>(<em>idx</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>1-based index of the first result to be retrieved.</dd></dl>
      <dl></dl>
    <hr></hr>
<a name="maxResults%28Int%29"></a><dl>
      <dt>
        
        <code></code>
        <code>def</code>
        <em>maxResults</em>(<em>n</em> : <a href="http://www.scala-lang.org/docu/files/api/scala/Int.html" target="_self">Int</a>) : <a href="../../../com/google/gdata/Query.html" target="_self">Query</a>
      </dt>
      <dd></dd>
    </dl>
      <dl><dd>Maximum number of results to be retrieved.</dd></dl>
      <dl></dl>
    <hr></hr></div>


    <hr></hr>
        <table summary="" class="navigation">
        <tr>
          <td class="navigation-links" valign="top">
            <!-- <table><tr></tr></table> -->
          </td>
          <td align="right" valign="top" style="white-space:nowrap;" rowspan="2">
            <div class="doctitle-larger">GData Scala Client Library Documentation</div>
          </td>
        </tr>
        <tr><td></td></tr>
      </table>
      </body>
      </html>